home *** CD-ROM | disk | FTP | other *** search
/ Libris Britannia 4 / science library(b).zip / science library(b) / HAMRADIO / FLEXPAC4.ZIP / QUICKDOC.TXT < prev    next >
Text File  |  1993-12-21  |  13KB  |  390 lines

  1.  FFFFFFFF  LL        EEEEEEEE  XX     XX  PPPPPP       AA       CCCCC
  2.  FF        LL        EE         XX   XX   PP    PP    AAAA    CC    CC
  3.  FF        LL        EE          XX XX    PP    PP   AA  AA   CC
  4.  FFFF      LL        EEEE         XXX     PPPPPP    AA    AA  CC
  5.  FF        LL        EE          XX XX    PP        AAAAAAAA  CC
  6.  FF        LL        EE         XX   XX   PP        AA    AA  CC    CC
  7.  FF        LLLLLLLL  EEEEEEEE  XX     XX  PP        AA    AA   CCCCC
  8.  
  9. This is the "quick" documentation for FlexPac, which is distributed
  10. in the shareware version.  If you register, you will receive the
  11. full 55+ page printed User's Guide.  This file is not intended as a
  12. replacement for the documentation - it should be enough to install
  13. and try FlexPac and perhaps to whet your appetite!
  14.  
  15. The version being distributed vis shareware does not contain the
  16. full log function; all other features are in that package.
  17.  
  18. You may use this version as-is, and you may distribute to friends or
  19. place on BBS's, as long as the entire package is distributed.  See
  20. files README.1ST and ORDER.TXT for ordering information.
  21.  
  22. DISCLAIMER:  The FlexPac program and its ancillary support programs
  23. can be freely distributed and used for any noncommercial purpose.
  24. However, there are no warranties or guaranties of any kind implied
  25. or expressed.  The user is responsible in full for all implications
  26. of the usage and installation of the program.  The author and other
  27. persons associated with the development of the program shall not be
  28. liable for any damages directly or indirectly resulting from the
  29. installation and/or use of these programs.
  30.  
  31. If you like and use the program, and wish to support the
  32. development of good, inexpensive software, please send a small
  33. registration fee of $40 plus $3 S&H to
  34.  
  35.         Rich Thorne WB5M
  36.         133 Light Falls Drive
  37.         Wake Forest, NC 27587
  38.  
  39. In return, you will receive the latest copy of the program on
  40. diskette and full documentation.  You also will receive notice of
  41. major fixes and enhancements.  Be sure to include your CALL and
  42. whether you want 360K/5.25" or 720K/3.25" diskettes.
  43.  
  44. For the full log version, include $75 + $3 S&H.
  45.  
  46. If you are not a registered user of FlexPac, you may still use it
  47. but you will occasionally get a small reminder written on your
  48. screen reminding you about Shareware.  When you register, you will
  49. be given a code based on your CALL; using the same procedure that is
  50. used to change colors and the screen window arrangement, you can
  51. then customize your version of FlexPac so that the reminder does
  52. not appear.
  53.  
  54. Quick Installation - Since you are reading this file, you have
  55. already done part of the installation.  If you downloaded FlexPac
  56. from a BBS, or got it from a friend, you probably got it in PKZIP
  57. format, and have already UNZIPped the .ZIP file.  If you received a
  58. distribution diskette from the author, follow the instructions at
  59. the end of the README.1ST file included in the package.
  60.  
  61. Simply, once you create a FLEXPAC subdirectory and copy (or UNZIP)
  62. all the files to it, all you have to do to start is to type the
  63. command FINSTALL.
  64.  
  65. Some of FlexPac's functions:
  66.   - optomized to work with the PacketCluster (tm)
  67.   - separate windows on the screen for output from the TNC, and your
  68.     keyed input - output appears simultaneously, even as you are
  69.     keying   - supports two simultaneous sessions (streams) in
  70.     different windows
  71.   - user defined scripts that can automatically process
  72.     logon, logoff, and other complex functions;  this includes a
  73.     WAIT function so that you can synchronize your script to the system
  74.     you are connected to
  75.   - pull down menus to easily select options
  76.   - the ability to schedule an event at a future time
  77.   - easy user function key definition
  78.   - capture of received data to a disk file
  79.   - optionally calls you by an alarm when someone connects to you
  80.   - you can edit the line you type, before actually sending it to
  81.     the TNC
  82.   - power typing with word wrap (use when sending messages)
  83.   - full log function with quick dupe (not in shareware version)
  84.   - displays country, beam heading, and distance on DX spots
  85.  
  86. System Requirements:
  87.   - IBM PC, PC Convertible, PS/2 or compatible.
  88.   - PC DOS 2.1 or later (PC DOS 3.0 or later required for DOS subset
  89.     feature)
  90.   - 256K RAM
  91.   - standard serial port (COM1 or COM2)
  92.   - color graphics adapter (CGA, EGA, VGA, PC Jr, or PC Convertible
  93.     are OK; IBM MDA (original Monochrome Display Adapter NOT
  94.     usable).
  95.   - color display (preferred; monochrome display on color adapter
  96.     can be used)
  97.   - TAPR-2 like TNC
  98.  
  99. Note: to use FlexPac you MUST set your TNC for 8 bits, no parity.
  100.  
  101. Keys:
  102. Enter      sends the current line you have typed
  103. Esc        sends the character that causes the TNC to go from
  104.            CONNECT mode to CMD mode - you should then see the CMD
  105.            prompt on the screen.  The character sent is $03
  106.            (hexadecimal 3). If you are in scroll back mode, Esc
  107.            cancels this mode and returns you to normal control.
  108. Home       moves the cursor to the beginning of the current input
  109.            line
  110. End        moves the cursor to the end of the current input line
  111. Ctrl-PgUp  eliminates the current window from the screen.
  112. Ctrl-PgDn  erases the current line you are typing in the key
  113.            area, clears the line, and sets the cursor back to column
  114.            one
  115. Ctrl-Home  clears the active window
  116. Ctrl-End   erases from the cursor to the end of the input line
  117. Ins        has no effect - always in Insert mode
  118. Del        deletes the character above the cursor
  119. Backspace  deletes the character to the left of the cursor and
  120.            moves the cursor to the left one character (rubout)
  121. Alt-s      activates the scroll back buffer for the current window
  122. Alt-d      activates the scroll back buffer for the DX window
  123. Alt-m      brings up the pull down menu
  124.  
  125.  
  126. FlexPac Commands:
  127. @ALARM
  128. @AL
  129.    manually turns on or off the same alarm tone as used in the
  130.    connect alarm or talk monitor; the alarm is also turned off by
  131.    the next keystroke
  132.         @ALARM | ON  |
  133.         @AL    | OFF |
  134.  
  135. @AT
  136.    specifies an event to be run in the future at the hour (hh) and
  137.    minute (mm) you specify - the action can be any text,
  138.    definition, or command; @AT OFF turns off any pending event
  139.         @AT | hh:mm action |
  140.             | OFF          |
  141.  
  142. @AUTOHELP
  143. @AH
  144.    specifies whether automatic help should be displayed when you enter
  145.    the incorrect syntax for a command
  146.         | @AUTOHELP |  | ON  |
  147.         | @AH       |  | OFF |
  148.  
  149. @AUTOSPOT
  150. @AH
  151.    specifies whether an automatic DX spot should be generated as a result
  152.    of adding a lot entry to the log database
  153.         | @AUTOSPOT |  | ON  |
  154.         | @AS       |  | OFF |
  155.  
  156. @BELLS
  157.    allows or suppresses the Ctrl-G (bell sound) on incoming messages
  158.         @BELLS | ON  |
  159.                | OFF |
  160.  
  161. @BLIP
  162. @BL
  163.    send an automatic message every nnn seconds
  164.         | @BLIP | | nnn message |
  165.         | @BL   | | OFF         |
  166.  
  167. @CAPTURE
  168. @CAP
  169.    controls logging of all data written in a window to a disk file
  170.         | @CAPTURE | | TO  | filename | |
  171.         | @CAP     |       | PRINTER  |
  172.                            | P        |
  173.                    | OFF                |
  174.  
  175. @CLEARSCREEN
  176. @CLS
  177.    clears the current window
  178.         | @CLEARSCREEN |
  179.         | @CLS         |
  180.  
  181. @CLUSTERCALL
  182. @CLCALL
  183.    identifies the callsign of the PacketCluster node; if you DIGI
  184.    through another station, use that station's callsign, not the
  185.    cluster callsign
  186.         | @CLUSTERCALL  |  call-sign
  187.         | @CLCALL       |
  188.  
  189. @CMD
  190.    tell the TNC to enter CMD mode
  191.         @CMD
  192.  
  193. @COMSTAT
  194.    displays COM port statistics
  195.         @COMSTAT
  196.  
  197. @CONNECTALARM
  198. @CA
  199.    turns ON or OFF the Connect Alarm facility
  200.         | @CONNECTALARM |  | ON  |
  201.         | @CA           |  | OFF |
  202.  
  203. @CRWAIT
  204.    used when BBS systems do not put carriage returns after each
  205.    line; @CRWAIT specifies how long in seconds to wait for a
  206.    carriage return; if not found, the pending line is written to
  207.    the screen anyhow
  208.         @CRWAIT seconds
  209.  
  210. @DEF
  211.    allows you to define your own function key definitions
  212.         @DEF |      | Fxx key-definition
  213.              | CTRL |
  214.              | C    |
  215.              | ALT  |
  216.              | A    |
  217.  
  218. @DELAY
  219.    delay `tt' seconds during script execution
  220.         @DELAY tt
  221.  
  222. @DO
  223.    causes the run of the script labeled "name"; for more
  224.    information on the proper format, see section "Testing
  225.    and Controlling In The FLEXPAC.CTL File"
  226.         @DO script-name | up to 9 tokens |
  227.  
  228. @DOS
  229. @DOSNW
  230. @DOSNOWAIT
  231.    do a DOS command or enter DOS subset (DOS 3.0 or later
  232.    required);  the NW or NOWAIT form does not wait for a keypress
  233.    after the DOS command is executed; to enter DOS subset mode,
  234.    just say @DOS
  235.         | @DOS       |  <dos-command>
  236.         | @DOSNW     |
  237.         | @DOSNOWAIT |
  238.  
  239. @DX
  240.    controls routing of DX spot information to the screen and/or
  241.    printer, and also controls whether there is a DX window on the
  242.    screen
  243.         @DX | ON  |  | SCREEN or S  |
  244.             | OFF |  | PRINTER or P |
  245.                      | WINDOW or W  |
  246.             | IDENTIFY | | ON  |
  247.             | ID       | | ONF |
  248.  
  249. @ERROR
  250.    sends an error message to the current window - the message is in
  251.    the error color, and the alarm tone also sounds
  252.         @ERROR message
  253.  
  254. @EXIT
  255.    stops the program immediately; the SHUTDOWN script is NOT run
  256.         @EXIT
  257.  
  258. @GMT
  259.    adjusts the FlexPac clock for GMT time; set @GMT to the amount to be
  260.    added or subtracted from the computer clock time to equal GMT time.
  261.         @GMT + or - difference in hours
  262.  
  263. @HALT
  264.    stops TNC communication; also see @RESUME
  265.         @HALT
  266.  
  267. @HELP
  268.    give you help on the various FlexPac commands
  269.         @HELP which-command
  270.  
  271. @KEYS
  272.    specifies the text that appears on the bottom line of the display
  273.         @KEYS |      | bottom-line-text
  274.               | CTRL |
  275.               | C    |
  276.               | ALT  |
  277.               | A    |
  278.  
  279. @LATLONG
  280. @LL
  281.    specifies your QTH location latitude and longtide; the format must
  282.    be as shown; decimals should not be used; xx and yy are whole
  283.    degrees
  284.         | @LATLONG | | xxNyyE |
  285.         | @LL      | | xxSyyE |
  286.                      | xxNyyW |
  287.                      | xxSyyW |
  288.  
  289. @LOG
  290.    starts up the logging window and log function
  291.         @LOG <log-file>
  292.  
  293. @MENU
  294.    display the pull down menu run
  295.         @MENU
  296.  
  297. @MONITOR
  298. @MON
  299.    causes a short beep on each output line
  300.         @MONITOR | ON  |
  301.                  | OFF |
  302.  
  303. @MYCALL
  304. @MYC
  305.    identifies your callsign to the system
  306.         | @MYCALL | callsign
  307.         | @MYC    |
  308.  
  309. @MYNAME
  310. @MYN
  311.    identifies your name to the system; the name can be one or more
  312.    words, but I recommend using only your first name.
  313.         | @MYNAME | your-name
  314.         | @MYN    |
  315.  
  316. @NEED
  317.    allows you to specify prefixes you need; when a DX spot appears
  318.    with the any prefix of the country you specify, the alarm sounds
  319.         @NEED | PREFIX prefix |
  320.               | RESET         |
  321.  
  322. @RESUME
  323.    resumes TNC communication; also see @HALT
  324.         @RESUME
  325.  
  326. @SAY
  327.    send a line to the current window
  328.         @SAY message
  329.  
  330. @SEND
  331.    causes the characters in the specified file to be transmitted
  332.         @SEND filename
  333.  
  334. @SHUTDOWN
  335. @SHUTD
  336.    causes running of the SHUTDOWN script, which should end with
  337.    @EXIT
  338.         | @SHUTDOWN |
  339.         | @SHUTD    |
  340.  
  341. @TALKMONITOR
  342. @TM
  343.    turns ON or OFF the Talk Monitor facility
  344.         | @TALKMONITOR |  | ON  |
  345.         | @TM          |  | OFF |
  346.  
  347. @TRACE
  348.    when you enter a FlexPac command, it is normally written to the
  349.    output screen; when you are writing a script, you may want to
  350.    suppress these; @TRACE ON turns them on, @TRACE OFF turns them off
  351.         @TRACE | ON  |
  352.                | OFF |
  353.  
  354. @WAIT
  355.    suspends running of the script until the specified text appears
  356.    in the TNC output, at which time running will resume; pressing
  357.    Esc on the keyboard aborts the WAIT, and the script will then
  358.    continue; the text can appear anywhere within the received line
  359.    to be detected properly; see also @WAITNOTFOUND and @WAITTIME
  360.         @WAIT text-to-wait-for
  361.  
  362. @WAITNOTFOUND
  363. @WNF
  364.    identifies the script that should be run when an @WAIT fails
  365.    (i.e. the text is not found within the default time or the time
  366.    specified by @WAITTIME
  367.         | @WAITNOTFOUND | script-name
  368.         | @WNF          |
  369.  
  370. @WAITTIME
  371. @WT
  372.    overrides the default time (in seconds) of how long to wait for
  373.    the text in an @WAIT command to appear
  374.         | @WAITTIME | seconds
  375.         | @WT       |
  376.  
  377. @WORDWRAP
  378. @WW
  379.    enables or disables power typing and word wrap
  380.         | @WORDWRAP |  | ON  |
  381.         | @WW       |  | OFF |
  382.  
  383.  
  384. Scripts:
  385.  
  386. You can create scripts of commands.  Each script begins with :label,
  387. and ends with a :.  Execute the script using the @DO command.  All
  388. scripts must be in the FLEXPAC.CTL file - see this file for
  389. examples.
  390.